home *** CD-ROM | disk | FTP | other *** search
/ Creative Computers / Creative Computers CD-ROM, Volume 1 (Legendary Design Technologies, Inc.)(1994).iso / shareware / telecom / term_4.1 / documentation / xpr_libs / xprkermit.doc < prev    next >
Text File  |  1994-11-17  |  27KB  |  544 lines
  1.                               XPR Kermit
  2.                              Version 2.30
  3.                            February 14, 1993
  4.  
  5.                   Frank da Cruz - Columbia University
  6.                Stephen R. Walton - Cal State Northridge
  7.  
  8. This is an implentation of an External Protocol (XPR) library for the
  9. Kermit file transfer protocol.  In keeping with the Kermit documents,
  10. here is a list of the items supported and not supported.
  11.  
  12. XPR Kermit Capabilities At A Glance:
  13.  
  14.   Local operation:                   Yes
  15.   Remote operation:                  Yes
  16.   Transfer text files:               Yes
  17.   Transfer binary files:             Yes
  18.   International text:                No
  19.   Wildcard send:                     Yes, if supported by comm program
  20.   File transfer interruption:        Yes
  21.   Filename collision actions:        Yes
  22.   Can time out:                      Yes
  23.   8th-bit prefixing:                 Yes
  24.   Repeat count prefixing:            Yes
  25.   Alternate block checks:            Yes
  26.   Automatic parity detection:        No
  27.   Dynamic packet length:             Yes
  28.   CONNECT mode:                      *
  29.   Terminal emulation:                *
  30.   Key mapping:                       *
  31.   Communication settings:            *
  32.   Transmit BREAK:                    *
  33.   Support for dialout modems:        *
  34.   TCP/IP support:                    *
  35.   X.25 support:                      *
  36.   IBM mainframe communication:       *
  37.   Transaction logging:               No
  38.   Session logging:                   No
  39.   Debug logging:                     No
  40.   Packet logging:                    No
  41.   Act as server:                     No
  42.   Talk to server:                    Yes
  43.   Advanced server functions:         No
  44.   Security for server:               No
  45.   Local file management:             N/A
  46.   Command/Init files:                N/A
  47.   Long packets:                      Yes
  48.   Sliding Windows:                   Yes
  49.   File attributes packets:           Yes, but limited by XPR protocol
  50.   Command macros:                    *
  51.   Script programming language:       *
  52.   Raw file transmit and capture:     *
  53.  
  54. The items marked with a '*' above are those which are to be provided by
  55. the calling terminal emulation program.  Notice that, although XPR
  56. Kermit itself cannot be a "Kermit server," often the communication
  57. program's scripting capability will allow XPR Kermit to be used for the
  58. unattended transfer of files between the Amiga and a remote machine.
  59.  
  60. I. Introduction
  61. ---------------
  62.  
  63. XPR Kermit implements the Kermit file transfer protocol in the form of
  64. an Amiga External Protocol (XPR) library.  This allows the addition of
  65. an up-to-date version of the Kermit protocol to any communications
  66. program which supports the XPR specification.  For further information
  67. on Kermit, read the book "Kermit:  A File Transfer Protocol" by Frank
  68. da Cruz, 1986, Digital Press.
  69.  
  70. Please note that this document assumes you already have some
  71. understanding of what the Kermit protocol is, and how to use it.  I
  72. have tried to include a few hints about common problems, but there is
  73. no substitute for obtaining and using a copy of the documentation for
  74. the Kermit on the other system to which you will be talking.  In
  75. addition, two commercial books are available.  "Kermit:  A File
  76. Transfer Protocol" by Frank da Cruz describes the protocol in some
  77. detail.  While aimed at those writing a Kermit program, it contains a
  78. good deal of useful information about Kermit itself.  "C Kermit" by
  79. Christine Gianone and Frank da Cruz, is a wealth of good introductory
  80. information about any version of Kermit.  In addition, the latter book
  81. is also the documentation for the standalone version of C Kermit which
  82. is available for the Amiga.
  83.  
  84. The Kermit protocol, and XPR Kermit, are copyright by Columbia
  85. University.  XPR Kermit is subject to the same restrictions as any
  86. other version of Kermit.  In particular, XPR Kermit may be included as
  87. part of a commercial package, provided the cost of said package is not
  88. increased as a result.
  89.  
  90. I cannot resist saying a few words in support of Kermit.  Unlike many
  91. other file transfer protocols such as the X/Y/ZMODEM family, the design
  92. of the Kermit protocol started with the assumption that communication
  93. lines are unreliable and quirky.  Kermit's slightly lower efficiency on
  94. good lines is more than compensated for by the fact that it can often
  95. successfully transfer files under conditions where other protocols
  96. fail.  It can transfer binary files over a seven-bit-wide communication
  97. line, or one which "eats" most control characters;  in fact, only two
  98. binary characters, the start-of-packet and end-of-packet markers, need
  99. be passed unchanged by the line.
  100.  
  101. II.  Installation
  102. -----------------
  103.  
  104. To install XPR Kermit, simply copy the file "xprkermit.library" to your
  105. LIBS: directory, and request your comm program to use XPRKERMIT as its
  106. external file transfer protocol.
  107.  
  108. XPR Kermit supports Version 2.0 of the XPR Protocol specification.  For
  109. more details on this, I recommend that you find a copy of the XPR
  110. Zmodem library, version 2.0.  Its documentation contains a good deal of
  111. the justification and philosophy of external protocol libraries, which
  112. I won't repeat here.  Among the programs supporting the XPR
  113. specification are the commercial programs A-Talk III and JRComm and the
  114. free programs VLT, Term, and NComm.
  115.  
  116.  
  117. III. Setting Options
  118. --------------------
  119.  
  120. XPR Kermit supports the parts of the Kermit protocol outlined in the
  121. table above.  There are currently nine user-settable parameters in XPR
  122. Kermit, which cover the parameters which are most often necessary to
  123. customize. If your communications problem is especially severe--for
  124. example, your method of connection to another system swallows
  125. characters which are special to Kermit, such as control-A--you may
  126. need to get a copy of the stand-alone Kermit program, C Kermit for the
  127. Amiga, distributed via many paths. The current version is 5A(189).
  128.  
  129. There are actually two sets of "setup" parameters in XPR Kermit.  The
  130. first set are commands which XPR Kermit can send to a remote Kermit
  131. server. These are not actually setups, but are in fact commands to XPR
  132. Kermit which cause it to communicate with a remote Kermit server.  The
  133. fourth command in this group is "Change Options," which causes no
  134. communication.  Instead, you are requested for changes in the current
  135. values of the parameters which Kermit will use for communication.
  136.  
  137. These items can be set in one of two ways.  One method is with a simple
  138. character string which is sent to XPR Kermit by the comm program;  this
  139. string will hereafter be referred to as the "init string."  This is
  140. generally done if an environment variable named XPRKERMIT exists and
  141. has a value, in which case XPR Kermit is sent the value when you first
  142. select XPR Kermit as your protocol.  Some comm programs also allow an
  143. initialization string to be sent in other ways, such as from a script;
  144. VLT, for example, has an INITXPR script command.  The format of this
  145. string is specified by the external protocol.
  146.  
  147. The second, more elegant method, is with some type of requester or set
  148. of requesters.  In this case, you will be presented by your comm
  149. program with a set of Intuition gadgets of some type which allow the
  150. choice of XPR Kermit commands and the setting of the options.
  151.  
  152. However, the string method has the advantage of giving one the ability
  153. to change external protocol settings non-interactively, such as from a
  154. script. In the case of XPR Kermit, such a script can actually command
  155. XPR Kermit to perform communication.  One obvious use of this is to
  156. transfer an entire directory tree from your Amiga to a remote machine: 
  157. you can make the remote Kermit a server and command it to perform the
  158. appropriate CD commands, then transfer files.
  159.  
  160. The currently supported XPR Kermit server commands are listed below.
  161. The format of the init string is in parentheses, generally simply a
  162. single letter.
  163.  
  164.     Kermit Finish (F):  Tells a Kermit server that you are done.  The
  165.     remote server will stop being a server.
  166.  
  167.     Kermit Bye (B):  Tells a Kermit server that you are done;  the server
  168.     will exit and log you off the remote machine.
  169.  
  170.     Kermit CD (C{dir}):  Change the default directo